home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2004 #9 / Amiga Plus CD - 2004 - No. 09.iso / amigaplus / games / openttd / readme.txt < prev    next >
Text File  |  2004-08-03  |  7KB  |  208 lines
  1. OpenTTD README
  2. Last updated:    $LastChangedDate: 2004-04-26 12:48:21 +0200 (Mon, 26 Apr 2004) $
  3. Release version: 0.3.1
  4. ------------------------------------------------------------------------
  5.  
  6.  
  7. Table of Contents:
  8. ------------------
  9. 1.0) About
  10. 2.0) Contacting
  11.  * 2.1 Reporting Bugs
  12. 3.0) Supported Platforms
  13. 4.0) Running OpenTTD
  14. 5.0) OpenTTD features
  15. 6.0) Configuration File
  16. 7.0) Compiling
  17. 8.0) Translating
  18.  * 8.1 Guidelines
  19.  * 8.2 Translation
  20.  * 8.3 Previewing
  21. X.X) Credits
  22.  
  23.  
  24. 1.0) About:
  25. ---- ------
  26. OpenTTD is a clone of Transport Tycoon Deluxe, a popular game originally
  27. written by Chris Sawyer.  It attempts to mimic the original game as closely
  28. as possible while extending it with new features.
  29.  
  30.  
  31. 2.0) Contacting:
  32. ---- ----------
  33. The easiest way to contact the OpenTTD team is by submitting bug reports or
  34. posting comments in our forums. You can also chat with us on IRC (#openttd
  35. on irc.freenode.net).
  36.  
  37. The OpenTTD homepage is http://www.openttd.com/.
  38.  
  39. You can find a forum for OpenTTD at
  40. http://www.tt-forums.net/index.php?c=20
  41.  
  42.  
  43. 2.1) Reporting Bugs:
  44. ---- ---------------
  45. To report a bug, please create a SourceForge account and follow the bugs
  46. link from our homepage. Please make sure the bug is reproducible and
  47. still occurs in the latest daily build or the current SVN version. Also
  48. please look through the existing bug reports briefly to see whether the bug
  49. is not already known.
  50.  
  51. The SourceForge project page URL is: http://sourceforge.net/projects/openttd/
  52. Click on "Bugs" to see the bug tracker.
  53.  
  54. Please include the following information in your bug report:
  55.         - OpenTTD version (PLEASE test the latest SVN/daily build)
  56.         - Bug details, including instructions how to reproduce it
  57.         - Platform and compiler (Win32, Linux, FreeBSD, ...)
  58.         - Attach a save game or a screenshot if possible
  59.         - If this bug only occurred recently please note the last
  60.           version without the bug and the first version including
  61.           the bug. That way we can fix it quicker by looking at the
  62.           changes made.
  63.  
  64.  
  65. 3.0) Supported Platforms:
  66. ---- --------------------
  67. OpenTTD has been ported to several platforms and operating systems. It shouldn't
  68. be very difficult to port it to a new platform. The currently working platforms
  69. are:
  70.  
  71.     Windows - Win32 GDI (faster) or SDL
  72.     Linux - SDL
  73.     FreeBSD - SDL
  74.     MacOS - SDL
  75.     BeOS - SDL
  76.  
  77.  
  78. 4.0) Running OpenTTD:
  79. ---- ----------------
  80.  
  81. Before you run OpenTTD, you need to put the game's datafiles into the data/
  82. subdirectory. You need the following files from the original Windows version
  83. of TTD as OpenTTD makes use of the original TTD artwork.
  84.  
  85. IMPORTANT! You need the files from the WINDOWS version of TTD.
  86.  
  87. List of the required files:
  88. sample.cat
  89. trg1r.grf
  90. trgcr.grf
  91. trghr.grf
  92. trgir.grf
  93. trgtr.grf
  94.  
  95. If you want music you need to copy the gm/ folder from Windows TTD.
  96.  
  97.  
  98. 5.0) OpenTTD features:
  99. ---- -----------------
  100.  
  101. OpenTTD has a lot of features going beyond the original TTD emulation.
  102. Currently there is unfortunately no comprehensive list of features. You could
  103. check the features list on the web, and some optional features can be
  104. controlled through the Configure patches dialog. We also implement some
  105. features known from TTDPatch (http://www.ttdpatch.net/).
  106.  
  107. Several important non-standard controls:
  108.  
  109. * Use Ctrl to place presignals
  110. * Ctrl-d toggles double mode on win32
  111.  
  112.  
  113. 6.0) Configuration File:
  114. ---- -------------------
  115. The configuration file for OpenTTD (openttd.cfg) is in a simple windows-like
  116. .INI format. It's mostly undocumented.
  117.  
  118.  
  119. 7.0) Compiling:
  120. ---- ----------
  121. Windows:
  122.   You need Microsoft Visual Studio 6 or .NET. Open the project file
  123.   and it should build automatically. In case you don't build with SDL,
  124.   you need to remove WITH_SDL from the project settings.
  125.  
  126. Unix:
  127.   OpenTTD can be built either with "make" or with "jam". To build with
  128.   "make", just type "make", or "gmake" on non-gnu systems. To build with "jam",
  129.   first run "./configure" and then "jam". Note that you need SDL to compile
  130.   OpenTTD.
  131.  
  132. MacOS:
  133.   Use "make -f makefile.osx".
  134.  
  135. BeOS:
  136.   Use "jam".
  137.  
  138.  
  139. 8.0) Translating:
  140. ---- -------------------
  141. See http://www.openttd.com/translating.php for up-to-date information.
  142.  
  143. 8.1) Guidelines:
  144. ---- -------------------
  145. Here are some translation guidelines which you should follow closely.
  146.  
  147.     * Please contact the development team before begining the translation process!
  148.       This avoids double work, as someone else may have already started translating to the same language.
  149.     * Translators must use the charater set "Windows latin-1", also known as ISO 8859-1.
  150.       Otherwise, some characters will not display correctly in the game.
  151.  
  152. 8.2) Translation:
  153. ---- -------------------
  154. So, now that you've notified the development team about your intention to translate
  155. (You did, right? Of course you did.) you can pick up english.txt (found in the SVN repository
  156. under /lang) and translate.
  157.  
  158. You must change the first two lines of the file appropriately:
  159.  
  160. ##name English-Name-Of-Language
  161. ##ownname Native-Name-Of-Language
  162.  
  163. Note: Do not alter the following parts of the file:
  164.  
  165.     * String identifiers (the first word on each line)
  166.     * Parts of the strings which are in curly braces (such as {STRING})
  167.     * Lines beginning with ## (such as ##id), other than the first two lines of the file
  168.  
  169. 8.3) Previewing:
  170. ---- -------------------
  171. In order to view the translation in the game, you need to compile your language file
  172. with the strgen utility, which is now bundled with the game.
  173.  
  174. strgen is a command-line utility. It takes the language filename as parameter.
  175. Example:
  176.  
  177. strgen lang/german.txt
  178.  
  179. This results in compiling german.txt and produces another file named german.lng.
  180. Any missing strings are replaced with the english strings. Note that it looks for english.txt
  181. in the lang subdirectory, which is where your language file should also be.
  182.  
  183. That's all! You should now be able to select the language in the game options.
  184.  
  185.  
  186. X.X) Credits:
  187. ---- --------
  188. The OpenTTD team:
  189.   Ludvig Strigeus (ludde)     - OpenTTD author, main coder.
  190.   Serge Paquet (vurlix)       - Assistant project manager, coder and webmaster.
  191.   Dominik Scherer (dominik81) - Many patches
  192.   Owen Rudge (orudge)         - Contributor, forum host.
  193.   Bjarni Corfitzen (Bjarni)   - MacOS port
  194.   Cian Duffy (MYOB)           - BeOS port / manual writing
  195.   Viktor Strigeus (wiggo)     - Web hosting services
  196.   
  197. Thanks to:
  198.   Bug Reporters - Thanks for all bug reports.
  199.   Josef Drexler - For his great work on TTDPatch.
  200.   Marcin Grzegorczyk - For his TTDPatch work and documentation of TTD internals and graphics.
  201.   Mike Ragsdale - OpenTTD installer
  202.   truesatan - Some patches
  203.   Michael Polnick - Some patches
  204.   Michael Blunck - Nice graphics
  205.   George - Canal graphics
  206.   Chris Sawyer - For an amazing game.
  207.   
  208.